<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>EJAM/EJSCREEN comparisons - Convert output of ejscreenapi_plus to format of ejamit table of sites — ejscreenapi2ejam_format • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="EJAM/EJSCREEN comparisons - Convert output of ejscreenapi_plus to format of ejamit table of sites — ejscreenapi2ejam_format"><meta name="description" content="Used by ejscreenit_for_ejam() to make it easier to compare EJScreen and EJAM results"><meta property="og:description" content="Used by ejscreenit_for_ejam() to make it easier to compare EJScreen and EJAM results"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>EJAM/EJSCREEN comparisons - Convert output of ejscreenapi_plus to format of ejamit table of sites</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/ejscreenit_for_ejam.R" class="external-link"><code>R/ejscreenit_for_ejam.R</code></a></small>
      <div class="d-none name"><code>ejscreenapi2ejam_format.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Used by <code><a href="ejscreenit_for_ejam.html">ejscreenit_for_ejam()</a></code> to make it easier to compare EJScreen and EJAM results</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ejscreenapi2ejam_format</span><span class="op">(</span></span>
<span>  <span class="va">ejscreenapi_plus_out</span>,</span>
<span>  fillmissingcolumns <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  ejamcolnames <span class="op">=</span> <span class="cn">NULL</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-ejscreenapi-plus-out">ejscreenapi_plus_out<a class="anchor" aria-label="anchor" href="#arg-ejscreenapi-plus-out"></a></dt>
<dd><p>results of ejscreenapi_plus() or also
could be results of ejscreenit()$table even though the colnames differ,
because they get converted here in that case.
Alternatively also can be the whole list output of ejscreenit()
not just ejscreenit()$table, which this function will figure out.</p></dd>


<dt id="arg-fillmissingcolumns">fillmissingcolumns<a class="anchor" aria-label="anchor" href="#arg-fillmissingcolumns"></a></dt>
<dd><p>optional. set to TRUE if you want the output
to have exactly all the same columns as the EJAM table would, and
fill in with NA values all the columns not provided by EJScreen API.</p></dd>


<dt id="arg-ejamcolnames">ejamcolnames<a class="anchor" aria-label="anchor" href="#arg-ejamcolnames"></a></dt>
<dd><p>optional. if specified as vector of colnames, it
overrides the assumed colnames that would have been taken to be
colnames(testoutput_ejamit_10pts_1miles$results_bysite).
Any colnames you specify here will be the colnames of the output
if fillmissingcolumns = TRUE, or else those not in names(ejscreenapi_plus_out)
will be omitted.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>A data.table not just data.frame, with some or all of the columns
found in output of ejamit()$results_bysite</p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="ejscreenit_for_ejam.html">ejscreenit_for_ejam()</a></code> <code><a href="ejscreen_vs_ejam.html">ejscreen_vs_ejam()</a></code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span>
<span>  <span class="va">y1</span> <span class="op">&lt;-</span> <span class="fu"><a href="ejscreenit_for_ejam.html">ejscreenit_for_ejam</a></span><span class="op">(</span><span class="va">testpoints_10</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">2</span>, <span class="op">]</span>, radius <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span>
<span></span>
<span>   <span class="va">x</span> <span class="op">&lt;-</span> <span class="fu"><a href="ejscreenapi_plus.html">ejscreenapi_plus</a></span><span class="op">(</span><span class="va">testpoints_10</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">2</span>, <span class="op">]</span>, radius <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span>
<span>   <span class="va">y</span> <span class="op">&lt;-</span> <span class="fu">ejscreenapi2ejam_format</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span>
<span>   <span class="va">ejamvars</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">testoutput_ejamit_10pts_1miles</span><span class="op">$</span><span class="va">results_bysite</span><span class="op">)</span></span>
<span>   <span class="fu"><a href="https://rdrr.io/r/base/all.equal.html" class="external-link">all.equal</a></span><span class="op">(</span></span>
<span>     <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">y</span><span class="op">)</span>, </span>
<span>     <span class="va">ejamvars</span><span class="op">[</span><span class="va">ejamvars</span> <span class="op"><a href="https://rdrr.io/r/base/match.html" class="external-link">%in%</a></span> <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">y</span><span class="op">)</span><span class="op">]</span></span>
<span>  <span class="op">)</span></span>
<span>  </span>
<span>  <span class="va">z</span> <span class="op">&lt;-</span> <span class="fu">ejscreenapi2ejam_format</span><span class="op">(</span><span class="va">x</span>, fillmissingcolumns <span class="op">=</span> <span class="cn">T</span><span class="op">)</span></span>
<span>  <span class="fu"><a href="https://rdrr.io/r/base/all.equal.html" class="external-link">all.equal</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">z</span><span class="op">)</span>, <span class="va">ejamvars</span><span class="op">)</span></span>
<span>  </span>
<span>  <span class="co"># for convenience also can do this:</span></span>
<span>  <span class="va">x</span> <span class="op">&lt;-</span> <span class="fu">ejscreenapi2ejam_format</span><span class="op">(</span><span class="op">)</span></span>
<span>  </span>
<span>  <span class="op">}</span> <span class="co"># }</span></span>
<span>  </span>
<span>  </span>
<span>  </span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

